gridpack::utility::Indexed Class Reference

#include <indexed.hpp>

List of all members.

Public Types
typedef int	IndexType
	The index type.
Public Member Functions
	Indexed (void)
	Default constructor.
	Indexed (const Indexed &old)
	Protected copy constructor to avoid unwanted copies.
virtual	~Indexed (void)
	Destructor.
IndexType	get_local_index (void) const
	Get the local index of this instance.
void	set_local_index (const IndexType &l)
	Get the local index of this instance.
IndexType	get_global_index (void) const
	Get the global index of this instance.
void	set_global_index (const IndexType &g)
	Set the global index of this instance.

---

Member Typedef Documentation

typedef int gridpack::utility::Indexed::IndexType

The index type.

To add some flexibility. This may need to be a 64-bit integer or unsigned or whatever.

---

Constructor & Destructor Documentation

gridpack::utility::Indexed::Indexed

(

void

)

Default constructor.

gridpack::utility::Indexed::Indexed

(

const Indexed &

old

)

Protected copy constructor to avoid unwanted copies.

virtual gridpack::utility::Indexed::~Indexed

(

void

)

[virtual]

Destructor.

---

Member Function Documentation

IndexType gridpack::utility::Indexed::get_global_index

(

void

)

const

Get the global index of this instance.

IndexType gridpack::utility::Indexed::get_local_index

(

void

)

const

Get the local index of this instance.

void gridpack::utility::Indexed::set_global_index

(

const IndexType &

g

)

Set the global index of this instance.

void gridpack::utility::Indexed::set_local_index

(

const IndexType &

l

)

Get the local index of this instance.

---

The documentation for this class was generated from the following file:

• indexed.hpp